<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-manual-qdocconf.qdoc -->
  <title>Format-specific Configuration Variables | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Format-specific Configuration Variables</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="23-qdoc-configuration-cppvariables.html" />
  <link rel="next" href="25-qdoc-configuration-derivedprojects.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="23-qdoc-configuration-cppvariables.html">C++ Specific Configuration Variables</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="25-qdoc-configuration-derivedprojects.html">Supporting Derived Projects</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#html-footer">HTML.footer</a></li>
<li class="level1"><a href="#format-nosubdirs">&lt;FORMAT&gt;.nosubdirs</a></li>
<li class="level1"><a href="#format-outputsubdir">&lt;FORMAT&gt;.outputsubdir</a></li>
<li class="level1"><a href="#html-postheader">HTML.postheader</a></li>
<li class="level1"><a href="#format-quotinginformation">&lt;FORMAT&gt;.quotinginformation</a></li>
<li class="level1"><a href="#html-style">HTML.style</a></li>
<li class="level1"><a href="#html-stylesheets">HTML.stylesheets</a></li>
<li class="level1"><a href="#format-tocdepth">&lt;FORMAT&gt;.tocdepth</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Format-specific Configuration Variables</h1>
<span class="subtitle"></span>
<!-- $$$24-qdoc-configuration-htmlvariables.html-description -->
<div class="descr"> <a name="details"></a>
<p>The format-specific configuration variables define the generated documentation's style, or define the contents of the documentation's footer or postheader.</p>
<p>Some of the configuration values are relevant only for the HTML output format and their values contain raw HTML.</p>
<a name="html-footer-variable"></a><a name="html-footer"></a>
<h2 id="html-footer">HTML.footer</h2>
<p>The <code>HTML.footer</code> variable defines the content of the generated HTML documentation's footer.</p>
<p>The footer is rendered at the bottom of the generated documentation page.</p>
<p>The variable's value is given as raw HTML code enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">

  HTML.footer = &quot;&lt;p /&gt;&lt;address&gt;&lt;hr /&gt;&lt;div align=\&quot;center\&quot;&gt;\n&quot; \
                ..&#x2e;
                &quot;&lt;/tr&gt;&lt;/table&gt;&lt;/div&gt;&lt;/address&gt;&quot;

</pre>
<a name="format-nosubdirs"></a><a name="format-nosubdirs"></a>
<h2 id="format-nosubdirs">&lt;FORMAT&gt;.nosubdirs</h2>
<p>A boolean value which, when <code>true</code>, enables single-directory output mode; all generated files go to <a href="24-qdoc-configuration-htmlvariables.html#format-outputsubdir">FORMAT.outputsubdir</a> directory, instead of a subdirectory based on the documentation project name.</p>
<a name="format-outputsubdir"></a><a name="format-outputsubdir"></a>
<h2 id="format-outputsubdir">&lt;FORMAT&gt;.outputsubdir</h2>
<p>Defines the subdirectory under <a href="22-qdoc-configuration-generalvariables.html#outputdir">outputdir</a> where documentation is generated.</p>
<pre class="cpp plain">

  HTML.nosubdirs = true
  HTML.outputsubdir = html

</pre>
<p>With above, the output goes to <code>&lt;outputdir&gt;/html</code>.</p>
<a name="html-postheader-variable"></a><a name="html-postheader"></a>
<h2 id="html-postheader">HTML.postheader</h2>
<p>The <code>HTML.postheader</code> variable defines the content of the generated HTML documentation's postheader.</p>
<p>The header is rendered at the top of the generated documentation page.</p>
<p>The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">

  HTML.postheader = &quot;&lt;table border=\&quot;0\&quot;..&#x2e;&quot; \
                    ..&#x2e;
                    &quot;&lt;img src=\&quot;images/qt-logo.png\&quot; \
                    &quot;align=\&quot;right\&quot; width=\&quot;203\&quot; height=\&quot;32\&quot;&quot;\
                   &quot;border=\&quot;0\&quot; /&gt;&quot; \
                    &quot;&lt;/td&gt;&lt;/tr&gt;&quot; \
                    &quot;&lt;/table&gt;&quot;

</pre>
<p>The complete variable entry in <a href="21-2-qtgui-qdocconf.html">qtgui.qdocconf</a> provides the standard header of the <a href="http://doc.qt.io/qt-5/qtgui-index.html">Qt GUI Documentation</a>.</p>
<a name="format-quotinginformation"></a><a name="format-quotinginformation"></a>
<h2 id="format-quotinginformation">&lt;FORMAT&gt;.quotinginformation</h2>
<p>A boolean value which, when <code>true</code>, generates references to quoted content (for example, <a href="07-0-qdoc-commands-includingexternalcode.html#quotefromfile-command">\quotefromfile</a> and <a href="07-0-qdoc-commands-includingexternalcode.html#snippet-command">\snippet</a> commands) instead of including the content directly.</p>
<p>Used currently for the <code>WebXML</code> output format.</p>
<pre class="cpp plain">

  WebXML.quotinginformation = true

</pre>
<a name="html-style-variable"></a><a name="html-style"></a>
<h2 id="html-style">HTML.style</h2>
<p>The HTML.style variable defines the style for the generated HTML documentation.</p>
<p>The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">

  HTML.style = &quot;h3.fn,span.fn&quot; \
               &quot;{ margin-left: 1cm; text-indent: -1cm; }\n&quot; \
               &quot;a:link { color: #004faf; text-decoration: none }\n&quot; \
               &quot;a:visited&quot; \
               &quot;{ color: #672967; text-decoration: none }\n&quot; \
               &quot;td.postheader { font-family: sans-serif }\n&quot; \
               &quot;tr.address { font-family: sans-serif }\n&quot; \
               &quot;body { background: #ffffff; color: black; }&quot;

</pre>
<a name="html-stylesheets-variable"></a><a name="html-stylesheets"></a>
<h2 id="html-stylesheets">HTML.stylesheets</h2>
<p>The HTML.stylesheets variable defines a list of stylesheets to use for the generated HTML documentation.</p>
<p>Using separate stylesheets for the documentation makes it easier to customize and experiment with the style used once the contents has been generated. Typically, it is only necessary to define a single stylesheet for any set of documentation; for example:</p>
<pre class="cpp plain">

  HTML.stylesheets = path/to/classic.css

</pre>
<p>QDoc expects to find stylesheets in the directory containing the <a href="21-2-qtgui-qdocconf.html">qtgui.qdocconf</a> file, and it will copy those specified to the output directory alongside the HTML pages.</p>
<a name="html-tocdepth"></a><a name="format-tocdepth"></a>
<h2 id="format-tocdepth">&lt;FORMAT&gt;.tocdepth</h2>
<p>The <code>&lt;FORMAT&gt;.tocdepth</code> variable defines how many document sections are printed in the table of contents. Setting tocdepth to <code>0</code> disables the table of contents while leaving it undefined prints all document sections.</p>
<p>Currently only has an effect for the HTML format:</p>
<pre class="cpp plain">

  HTML.tocdepth = 3

</pre>
</div>
<!-- @@@24-qdoc-configuration-htmlvariables.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="23-qdoc-configuration-cppvariables.html">C++ Specific Configuration Variables</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="25-qdoc-configuration-derivedprojects.html">Supporting Derived Projects</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
